Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc update #172

Merged
merged 6 commits into from
Sep 12, 2023
Merged

Doc update #172

merged 6 commits into from
Sep 12, 2023

Conversation

luke-hill
Copy link
Contributor

🤔 What's changed?

Add testing notes RE versions in readme

⚡️ What's your motivation?

Get more clarity on what is tested

🏷️ What kind of change is this?

  • 🏦 Refactoring/debt/DX (improvement to code design, tooling, documentation etc. without changing behaviour)
  • 🐛 Bug fix (non-breaking change which fixes a defect)
  • ⚡ New feature (non-breaking change which adds new behaviour)
  • 💥 Breaking change (incompatible changes to the API)

♻️ Anything particular you want feedback on?

📋 Checklist:

  • I agree to respect and uphold the Cucumber Community Code of Conduct
  • I've changed the behaviour of the code
    • I have added/updated tests to cover my changes.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

This text was originally generated from a template, then edited by hand. You can modify the template here.

README.md Outdated
- [Objective-C](./objective-c) - Not tested?
- [Perl](./perl) - Tested on Perl 5.14 and 5.36
- [PHP](./php) - Tested on PHP 8.1
- [Dart](./dart) - Tested on Dart 1.4
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is perishable information. It will go out of date when the Github Action is changed.

Consider removing the versions altogether and a second that describes how Gherkin is tested, refering to the CI files for specific versions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair point. But can you help with the 2 misunderstood ones? C/Obj C? Those appear wrong / untested

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

C is tested by

https://github.com/cucumber/gherkin/blob/main/.github/workflows/test-c.yml

Objective-C is untested.

Maybe put that in the readme for objective-c.

@luke-hill luke-hill merged commit e87f74b into main Sep 12, 2023
1 check passed
@luke-hill luke-hill deleted the doc_update branch September 12, 2023 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants